Skip to main content

🏃 Running a function locally

requirements
  • Being logged in
  • Being in the directory of the function

During the creation of GreenCloud we realised that the software developer would need a method by which they could test their software locally first before publishing it into the GreenCloud.

To do this we make use of Docker and a special command in the CLI.

To run your function, make sure to be in the same directory and simple type 

gccli fx start
$ gccli fx start
👷 Validating inputs...
🧭 Port → 8080
⌚ Timeout → 10
📍 No container for function running!
🚀 Building function function...
⏳️ Process may take a while, please wait...
🧩 Image building was successfully!
🔗 Running → http://localhost:8080
$ █

This will trigger the function to be built and then started as a container in docker, running on Port 8080.

You can then invoke the function by calling it via a web browser or using a web introspection tool like PostMan to pass values in the 'body' of the function.

http://localhost:8080

Hello from GO by GreenCloud!

There are a couple of parameters for the start call that are worth mentioning.

  • Using the -p parameter you can specify which port you want you function to be accessible from.
gccli fx start -p 3000
  • Using the -t parameter you can set the timeout value (in seconds) for how long you specify for the function to run before being timed out.
gccli fx start -t 5
  • This will cause any logging of the function to be displayed to the terminal.
gccli fx start -l